home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / man3 / DString.3 < prev    next >
Text File  |  1994-09-20  |  10KB  |  323 lines
  1. '\"
  2. '\" Copyright (c) 1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/DString.3,v 1.10 93/08/16 13:24:52 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS Tcl_DStringInit tclc 7.0
  206. .BS
  207. .SH NAME
  208. .na
  209. Tcl_DStringInit, Tcl_DStringAppend, Tcl_DStringAppendElement, Tcl_DStringStartSublist, Tcl_DStringEndSublist, Tcl_DStringLength, Tcl_DStringValue, Tcl_DStringTrunc, Tcl_DStringFree, Tcl_DStringResult \- manipulate dynamic strings
  210. .ad
  211. .SH SYNOPSIS
  212. .nf
  213. \fB#include <tcl.h>\fR
  214. .sp
  215. \fBTcl_DStringInit\fR(\fIdsPtr\fR)
  216. .sp
  217. char *
  218. \fBTcl_DStringAppend\fR(\fIdsPtr, string, length\fR)
  219. .sp
  220. char *
  221. \fBTcl_DStringAppendElement\fR(\fIdsPtr, string\fR)
  222. .sp
  223. \fBTcl_DStringStartSublist\fR(\fIdsPtr\fR)
  224. .sp
  225. \fBTcl_DStringEndSublist\fR(\fIdsPtr\fR)
  226. .sp
  227. int
  228. \fBTcl_DStringLength\fR(\fIdsPtr\fR)
  229. .sp
  230. char *
  231. \fBTcl_DStringValue\fR(\fIdsPtr\fR)
  232. .sp
  233. \fBTcl_DStringTrunc\fR(\fIdsPtr, newLength\fR)
  234. .sp
  235. \fBTcl_DStringFree\fR(\fIdsPtr\fR)
  236. .sp
  237. \fBTcl_DStringResult\fR(\fIinterp, dsPtr\fR)
  238. .SH ARGUMENTS
  239. .AS Tcl_DString newLength
  240. .AP Tcl_DString *dsPtr in/out
  241. Pointer to structure that is used to manage a dynamic string.
  242. .AP char *string in
  243. Pointer to characters to add to dynamic string.
  244. .AP int length in
  245. Number of characters from string to add to dynamic string.  If -1,
  246. add all characters up to null terminating character.
  247. .AP int newLength in
  248. New length for dynamic string, not including null terminating
  249. character.
  250. .BE
  251.  
  252. .SH DESCRIPTION
  253. .PP
  254. Dynamic strings provide a mechanism for building up arbitrarily long
  255. strings by gradually appending information.  If the dynamic string is
  256. short then there will be no memory allocation overhead;  as the string
  257. gets larger, additional space will be allocated as needed.
  258. .PP
  259. \fBTcl_DStringInit\fR initializes a dynamic string to zero length.
  260. The Tcl_DString structure must have been allocated by the caller.
  261. No assumptions are made about the current state of the structure;
  262. anything already in it is discarded.
  263. If the structure has been used previously, \fBTcl_DStringFree\fR should
  264. be called first to free up any memory allocated for the old
  265. string.
  266. .PP
  267. \fBTcl_DStringAppend\fR adds new information to a dynamic string,
  268. allocating more memory for the string if needed.
  269. If \fIlength\fR is less than zero then everything in \fIstring\fR
  270. is appended to the dynamic string;  otherwise \fIlength\fR
  271. specifies the number of bytes to append.
  272. \fBTcl_DStringAppend\fR returns a pointer to the characters of
  273. the new string.  The string can also be retrieved from the
  274. \fIstring\fR field of the Tcl_DString structure.
  275. .PP
  276. \fBTcl_DStringAppendElement\fR is similar to \fBTcl_DStringAppend\fR
  277. except that it doesn't take a \fIlength\fR argument (it appends
  278. all of \fIstring\fR) and it converts the string to a proper list element
  279. before appending.
  280. \fBTcl_DStringAppendElement\fR adds a separator space before the
  281. new list element unless the new list element is the first in a
  282. list or sub-list (i.e. either the current string is empty, or it
  283. contains the single character ``{'', or the last two characters of
  284. the current string are `` {'').
  285. \fBTcl_DStringAppendElement\fR returns a pointer to the
  286. characters of the new string.
  287. .PP
  288. \fBTcl_DStringStartSublist\fR and \fBTcl_DStringEndSublist\fR can be
  289. used to create nested lists.
  290. To append a list element that is itself a sublist, first
  291. call \fBTcl_DStringStartSublist\fR, then call \fBTcl_DStringAppendElement\fR
  292. for each of the elements in the sublist, then call
  293. \fBTcl_DStringEndSublist\fR to end the sublist.
  294. \fBTcl_DStringStartSublist\fR appends a space character if needed,
  295. followed by an open brace;  \fBTcl_DStringAppendElement\fR appends
  296. a close brace.
  297. Lists can be nested to any depth.
  298. .PP
  299. \fBTcl_DStringLength\fR is a macro that returns the current length
  300. of a dynamic string (not including the terminating null character).
  301. \fBTcl_DStringValue\fR is a  macro that returns a pointer to the
  302. current contents of a dynamic string.
  303. .PP
  304. \fBTcl_DStringTrunc\fR truncates a dynamic string to a given length.
  305. It has no effect if the string was already smaller than \fInewLength\fR.
  306. This procedure does not free up the string's storage space, even
  307. if the string is truncated to zero length, so \fBTcl_DStringFree\fR
  308. will still need to be called.
  309. .PP
  310. \fBTcl_DStringFree\fR should be called when you're finished using
  311. the string.  It frees up any memory that was allocated for the string
  312. and reinitializes the string's value to an empty string.
  313. .PP
  314. \fBTcl_DStringResult\fR sets the result of \fIinterp\fR to the value of
  315. the dynamic string given by \fIdsPtr\fR.  It does this by moving
  316. a pointer from \fIdsPtr\fR to \fIinterp->result\fR.
  317. This saves the cost of allocating new memory and copying the string.
  318. \fBTcl_DStringResult\fR also reinitializes the dynamic string to
  319. an empty string.
  320.  
  321. .SH KEYWORDS
  322. append, dynamic string, free, result
  323.